home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / s501wc.zip / SCHT!WC.DOC < prev    next >
Text File  |  1993-01-20  |  24KB  |  579 lines
  1.  
  2.    ┌──────┐ ┌──────┐ ┌─────┐  ┌─────┐ ┌─────┐ ┌─────┐ ┌─┐ ┌─┐ ┌─────┐ ┌─────┐
  3.    └──────┘ └──────┘ └─────┘  └─────┘ └─────┘ └─────┘ └─┘ └─┘ └─────┘ └─────┘
  4.    ┌──────┐ ┌──────┐ ┌──────┐ ┌─────┐ ┌──┐    ┌─┐     ┌─────┐ ┌─────┐   ┌─┐
  5.    └────┐ │ │ ┌──┐ │ │ ┌──┐ │ │ ┌┐ ┌┘ │ ┌┘    │ │     │ ┌─┐ │ │ ┌─┐ │   │ │
  6.    ┌────┘ │ │ │  │ │ │ └──┘ │ │ ││ │  │ └───┐ │ └───┐ │ │ │ │ │ │ │ │   │ │
  7.    └──────┘ └─┘  └─┘ └──────┘ └─┘└─┘  └─────┘ └─────┘ └─┘ └─┘ └─┘ └─┘   └─┘
  8.  
  9.           SabreChat! Version 5.00.00 Copyright (C) 1993 Shawn Gresham
  10.  
  11.                           Wildcat! Version 3.x Support
  12.  
  13.  
  14. What is SabreChat!?
  15. ───────────────────
  16.  
  17.         SabreChat! is simply a user to user chat program. It is run
  18.         from each node of a bulletin board system allowing the users
  19.         online to talk with each other.  This connection is made
  20.         possible by the SabreMixer! TSR that comes with the SabreChat!
  21.         package.  This particular version is for the Wildcat bulletin
  22.         board system version 3.x.
  23.  
  24.         This SabreChat! version has the following features:
  25.  
  26.           Line-by-line or character-by-character chat modes that
  27.           are toggled by the user.
  28.  
  29.           Communication between nodes separated by a multi-tasker or a
  30.           network in character-by-character mode.  Disk-based
  31.           communication in line-by-line mode.
  32.  
  33.           Full ANSI color coding support.
  34.  
  35.           Full user to user paging under WILDCAT.
  36.  
  37.           Multiple conferencing support for more than one group of user.
  38.  
  39.           Supports up to 50 nodes.
  40.  
  41.           Sysop-defined action commands for user entertainment.
  42.  
  43.           Name and Initial color prompting for user identification.
  44.  
  45.           Ability to capture conversations to a text file.
  46.  
  47.           Log file generation.
  48.  
  49. Requirements
  50. ────────────
  51.  
  52.         The following are required to execute SabreChat!:
  53.  
  54.                 8086 or better
  55.                 DOS 3.3 or newer
  56.                 a communication fossil for port access
  57.                 SHARE.EXE must be loaded
  58.  
  59.         SabreChat! uses the following files:
  60.  
  61.         File            Description                     Found
  62.         ─────────────── ───────────────────────         ───────
  63.         SCHAT!.EXE      Main Executable                 archive
  64.         SCHT!WC.DOC     Documentation                   archive
  65.         SMIXER!.COM     SabreMixer!                     archive
  66.         SMIXER!.DOC     Doc for SabreMixer!             archive
  67.  
  68.         SCHT!HI.ASC     welcome text (ASCII)            archive
  69.         SCHT!HI.ANS     welcome text (ANSI)             archive
  70.         SCHT!HLP.ASC    help text (ASCII)               archive
  71.         SCHT!HLP.ANS    help text (ANSI)                archive
  72.         SCHT!MNU.ASC    menu text (ASCII)               archive
  73.         SCHT!MNU.ANS    menu text (ANSI)                archive
  74.  
  75.         SCHT!ACT.EXE    action compiler                 archive
  76.         SCHT!ACT.TXT    sample actions (text)           archive
  77.         SCHT!ACT.DAT    sample actions (compiled)       archive
  78.  
  79.         SCHT!REG.EXE    registration program            archive
  80.         SCHT!KEY.DAT    registration key file           created
  81.  
  82.         SCHT!USR.SWD    user data                       created
  83.         SCHT!CNF.SWD    conference data                 created
  84.         SCHT!LIN.SWD    line data                       created
  85.         SCHT!LOG.SWD    log file                        created
  86.         SCHT!CAP.xxx    capture file for node xxx       created
  87.  
  88.                 ARCHIVE = found in the SabreChat! archive.
  89.                 CREATED = created by SabreChat!.
  90.  
  91.  
  92. Registering SabreChat!
  93. ──────────────────────
  94.  
  95.         The copy of SabreChat! that you possess is the full-working
  96.         version with only one drawback.  Users are limited to ten
  97.         minutes in the door before they are returned to the board.
  98.         Afterwards they may return to SabreChat! for another ten
  99.         minutes and so on.  This limitation is merely to allow the
  100.         user and sysop to have a sufficent evaluation periods to
  101.         determine if they wish to register SabreChat!.
  102.  
  103.         Why register at all then?  Well, there are few reasons you
  104.         might consider...
  105.  
  106.         1) Upon registration, you will be added to a list of names
  107.            that I personally inform when a newer version of SabreChat!
  108.            comes out.
  109.  
  110.         2) You will receive priority support, in the unlikely event that
  111.            you run into any problems or if you just have some questions.
  112.  
  113.         3) Registrations keep me informed on just how interested
  114.            people are in my software.  If I don't receive any feedback
  115.            then I can only assume that my efforts were in vain and I
  116.            should find something else to do.
  117.  
  118.         4) Registrations are forever.  Once registered, you will never
  119.            have to register for a newer version of SabreChat!.
  120.  
  121.         5) Upon receiving the registration key, the ten minute
  122.            limitation will be removed.
  123.  
  124.         To register SabreChat!, please send fifteen US dollars ($15
  125.         US) along with the following information to the address found
  126.         at the end of this document :
  127.  
  128.                 Registering person's (or company's) name
  129.                 Name of the bulletin board system
  130.                 Board number
  131.                 Fidonet address
  132.                 Where you found SabreChat!
  133.                 Version of SabreChat!
  134.                 Any Comments or Suggestions for a future version
  135.  
  136.         Be sure that the names given are the names that you wish to
  137.         appear in the registration.  The registration will look
  138.         similar to this:
  139.  
  140.         Registered to SHAWN GRESHAM of MAXIMUM INTENSITY.
  141.                       -------------    -----------------
  142.  
  143.         The information is merely for my records so that I can keep
  144.         tabs on where the program is headed and such.  Plus the
  145.         comments and suggestion are invaluable to the production of
  146.         future versions.
  147.  
  148.  
  149. Installation
  150. ────────────
  151.  
  152.         The following instructions explain how to install SabreChat!
  153.         onto your system.  Note that this installation assumes the
  154.         following directory structure:
  155.  
  156.                      C:\
  157.                       ┐
  158.                       ├─\WC
  159.                       │  │
  160.                       .  ├─\DATA
  161.                       .  │
  162.                          └─\WCWORK
  163.                             │
  164.                             ├─\NODE1
  165.                             │
  166.                             ├─\NODE2
  167.                             │
  168.                             .
  169.                             .
  170.  
  171.         If you have installed Wildcat using different pathnames then
  172.         you will have to modify the instructions accordingly.
  173.  
  174.         1. unzip the SabreChat! package into your c:\WC\DATA directory.
  175.  
  176.         2. add the line 'SET SCHAT!=C:\WC\DATA' to your AUTOEXEC.BAT.
  177.  
  178.         3. add the line 'C:\WC\DATA\SMIXER! N2' to your AUTOEXEC.BAT.
  179.            note that the parameter N needs to be set to the highest
  180.            node number on the whole system.  (example: for nodes 1,2,5
  181.            you would use N5 instead of N3).  For additional
  182.            information please see the SMIXER!.DOC that was included in the
  183.            archive.
  184.  
  185.         4. set up your MAIN1.RUN or MAIN2.RUN file as follows:
  186.  
  187.            C:\WC\DATA\SCHAT!.EXE YC:\WC\WCWORK\NODE%wcnodeid%
  188.  
  189.         5. In MakeWild, under the setup menu, raise the level of
  190.            access on Wildcat's internal Chat function so users no
  191.            longer have access to it.  Next, enable one of your DOS
  192.            hooks on the main menu (either 1 or 2 depending on the name
  193.            of your MAINx.RUN file) and assign it the letter T (or
  194.            anything you wish). Under the DOOR setup options menu in
  195.            MakeWild, be sure to make this hook multi-user.
  196.  
  197.         If everything is in order then you should have a working
  198.         version of SabreChat!.  I would check everything now and make
  199.         sure that all is working.  Afterwards, you may customize
  200.         SabreChat! to better fit your specific online needs...
  201.  
  202.  
  203. TroubleShooting
  204. ───────────────
  205.  
  206.         Here's a few tips that may help with problems that arise
  207.         after a while.  If you start getting 'ghost' users or
  208.         conferences, try deleting all the *.SWD files.
  209.  
  210.  
  211. Customizing SabreChat!
  212. ──────────────────────
  213.  
  214.         Using the installation instructions, you should have a
  215.         standard working version of SabreChat!.  The following
  216.         section gives a list of command line options that you
  217.         can use to customize the way SabreChat! works on your
  218.         system.  I would recommend make very few changes until
  219.         you are certain that the base setup will operate
  220.         correctly.   Customizing would complicate debugging a
  221.         problem.
  222.  
  223.         Note that some options are already set by the DOOR.SYS
  224.         file that Wildcat generates for you.  These commands are
  225.         identified by having [DOOR.SYS] after thier name.
  226.         Normally you would not have to set these commands unless
  227.         you wanted to over-ride the DOOR.SYS setting.
  228.  
  229.         The command line parameters are listed in the following
  230.         format:
  231.  
  232.         Option <letter>, <short description> [DOOR.SYS]
  233.  
  234.                 <full description>
  235.  
  236.                 Usage   : SCHAT! <option usage description>
  237.                 Default : SCHAT! <example>
  238.                                 Example of how to activate option from
  239.                                 command line.
  240.                           DOOR.SYS
  241.                                 Means that the option is read from
  242.                                 DOOR.SYS if the Y option has been set.
  243.                           None
  244.                                 Means that the option has no default
  245.                                 value or is not activated by default.
  246.                           AutoDetect
  247.                                 Means that SabreChat! tries to
  248.                                 determine this value when it is
  249.                                 executed, and that by setting this
  250.                                 option, you are overriding the
  251.                                 detected value.
  252.  
  253.  
  254.         Option A, Select Graphics Mode [DOOR.SYS]
  255.  
  256.                 This command is set by DOOR.SYS.
  257.  
  258.                 This command selects the graphic codes that SabreChat!
  259.                 uses to send colors to an online user.  SabreChat!
  260.                 supports two standard graphic conventions, ANSI and
  261.                 AVATAR.  As of now, Wildcat does not support the
  262.                 AVATAR graphic codes.  This option will be set by
  263.                 DOOR.SYS if you are using option Y (use door.sys),
  264.                 based on the user's flags in Wildcat.
  265.  
  266.                 Usage : SCHAT! A<0..3>
  267.  
  268.                         0       No graphic codes
  269.                         1       ANSI graphics
  270.                         2       AVATAR graphics
  271.                         3       Both ANSI and AVATAR
  272.  
  273.                 Example : SCHAT! A1
  274.                 Default : SCHAT! A0 or DOOR.SYS
  275.  
  276.         Option B, Black and White Local Screen
  277.  
  278.                 This command informs SabreChat! not to use colors
  279.                 locally.   Color codes will still be sent to the user
  280.                 online.  This is necessary on some black and white
  281.                 monitors that translate certain colors as black and
  282.                 cannot been seen against the black background.
  283.  
  284.                 Usage : SCHAT! B
  285.                 Default : Color used.
  286.  
  287.         Option C, Set Default Conference Name
  288.  
  289.                 This option sets the conference name that user will
  290.                 be joined to when he enters SabreChat!.
  291.  
  292.                 Usage   : SCHAT! C<conference name>
  293.                 Example : SCHAT! CCOMICS
  294.                 Default : SCHAT! CPUBLIC
  295.  
  296.         Option E, Enable DOS 3.3 COMMIT flushing
  297.  
  298.                 This option enables file flushing for some of the
  299.                 temporary files that SabreChat! uses to communicate.
  300.                 Enabling this will slow down operation a tad, but will
  301.                 ensure that the data gets written to the disk as soon
  302.                 as possible.  Do not use this unless some nodes are
  303.                 receiving the wrong text lines (ie. old lines of text
  304.                 or massive garbage, etc).
  305.  
  306.                 Usage   : SCHAT! E
  307.                 Default : Inactive
  308.  
  309.         Option G, Log Activity
  310.  
  311.                 This option creates a file called SCHT!LOG.SWD and
  312.                 logs the doors activity.  You can safely delete this
  313.                 file whenever it becomes to larger and SabreChat! will
  314.                 create a new one.  This keeps a list of who enters and
  315.                 leaves and any errors that may occur.
  316.  
  317.                 Usage: SCHAT! G
  318.                 Default: Disabled.
  319.  
  320.         Option L, Line-by-line Mode
  321.  
  322.                 By putting this option on the command line, SabreChat!
  323.                 will default to line-by-line mode instead of
  324.                 character-by-character mode.
  325.  
  326.                 Usage  : SCHAT! L
  327.                 Default: Disabled.
  328.  
  329.         Option M, User Prompting
  330.  
  331.                 This command sets the type of prompting that
  332.                 SabreChat! while use to distinguish between users.
  333.  
  334.                 Usage   : SCHAT! M<0..2>
  335.                                 0       No prompting
  336.                                 1       Full name prompting
  337.                                 2       Initial prompting
  338.                 Default : SCHAT! M2
  339.  
  340.         Option N, Select Node [DOOR.SYS]
  341.  
  342.                 This command is set by DOOR.SYS.
  343.  
  344.                 This option tells SabreChat! which node it is
  345.                 operating on.  This option is also read from DOOR.SYS
  346.                 if the Y option is selected and will not need to be
  347.                 explicitly set.
  348.  
  349.                 Usage   : SCHAT! N<node 1..50>
  350.                 Default : SCHAT! N1 or DOOR.SYS
  351.  
  352.         Option P, Select Online Communications Port [DOOR.SYS]
  353.  
  354.                 This command is set by DOOR.SYS.
  355.  
  356.                 This command sets the communications port (COM) that
  357.                 it will talk to an online user with.  A port value of
  358.                 zero is assumed to be a local user.  A communications
  359.                 fossil will be used to access the port.
  360.  
  361.                 Usage   : SCHAT! P<0,1..8> (local,com1..com8)
  362.                 Default : No ComPort or DOOR.SYS
  363.  
  364.         Option T, Set User Time Remaining [DOOR.SYS]
  365.  
  366.                 This command is set by DOOR.SYS.
  367.  
  368.                 This option tells SabreChat! how long the user has
  369.                 access to this door in minutes.  Once this time is
  370.                 used, the user is returned to the board.
  371.  
  372.                 NOTE : This command is ignored in the unregistered
  373.                        version of SabreChat! and the user time limit
  374.                        is set to 10 minutes.
  375.  
  376.                 Usage   : SCHAT! T<1..255 minutes>
  377.                 Default : SCHAT! T20 or DOOR.SYS
  378.  
  379.         Option U, Auto-Line Mode Switch
  380.  
  381.                 This command line option sets the number of users that
  382.                 must be in SabreChat! before SabreChat! will
  383.                 automatically switch to line-by-line mode.  Setting
  384.                 this value to 0, disables the auto-switch.
  385.  
  386.                 Usage   : SCHAT! U<number of users>
  387.                 Example : SCHAT! U5
  388.                         -- go to line-by-line mode when the 5th user
  389.                         enters a SabreChat! conference
  390.                 Default : SCHAT! U3
  391.  
  392.  
  393.         Option Y, Read User Information from DOOR.SYS
  394.  
  395.                 NOTE:  If you followed the installation instructions
  396.                        given earlier, then you are already using this
  397.                        command.
  398.  
  399.                 This option tells SabreChat! to read DOOR.SYS for
  400.                 information pertaining to the user setup.  This
  401.                 command will automatically set the user node, com
  402.                 port, graphic mode, and time remaining.  This options
  403.                 should not need to be set once the Y command has been
  404.                 used unless the values are desired to be forced.
  405.  
  406.                 Usage   : SCHAT! Y<path to DOOR.SYS>
  407.                 Default : None
  408.  
  409.         Option Z, Set Local Screen Length
  410.  
  411.                 This option informs SabreChat! of the size of the
  412.                 local screen.  Though the size of the local screen is
  413.                 read from BIOS upon program initialization, you may
  414.                 desired to force the size if SabreChat! does not read
  415.                 the value correctly or if you wish to make the
  416.                 SabreChat! window shorter than screen.  The latter use
  417.                 is nice if you are using SabreChat! in a windowed
  418.                 enviroment and you wish to see the status bar at the
  419.                 bottom of each window.
  420.  
  421.                 Usage   : SCHAT! Z<1..50 lines>
  422.                 Default : AutoDetect
  423.  
  424.         Option &, Immediate User Mode
  425.  
  426.                 This option allows you to use SabreChat! without the
  427.                 need of a NODEINFO.DAT file.  The user name is set to
  428.                 the name entered on the node specified by the N
  429.                 option, and on the port specified by the P option.
  430.  
  431.                 Usage   : SCHAT! &<firstname_Lastname>
  432.                 Default : SCHAT! None
  433.                 Example : SCHAT! &Shawn_Gresham
  434.  
  435.  
  436. Customizing Menus
  437. ─────────────────
  438.  
  439.         There are three screens in SabreChat! that can be modified.
  440.         These are SCHT!HLP, SCHT!MNU, and SCHT!HI.  Each consists of
  441.         two files that end with .ASC, a straight ASCII file, and .ANS,
  442.         an ANSI file.  You may modify these files as you wish to give
  443.         any extra information or flash to your copy of SabreChat!.
  444.         However, modifying the command names in the SCHT!MNU file will
  445.         NOT modify the command names in SabreChat!.  This will only
  446.         confuse your users.
  447.  
  448.         Also, some ANSI screens may contain commands that SabreChat!
  449.         does not correctly interpret.  This screens will appear wrong
  450.         on the local side only.
  451.  
  452. Action Commands
  453. ───────────────
  454.  
  455.         SabreChat!'s action feature allows the user to make gestures
  456.         with just a few keystrokes.  An example would be /SMILE that
  457.         sends "*** SHAWN GRESHAM smiles."  to each user in his
  458.         conference.  These commands are an attempt to give SabreChat!
  459.         a more conversation atmosphere.
  460.  
  461.         The action commands can be altered by modifing the file
  462.         SCHT!ACT.TXT.  Before doing so, be sure to change into the
  463.         directory containing that file.  Each line of SCHT!ACT.TXT
  464.         contains a one word command name (such as SMILE) and then the
  465.         rest of the line is what is output to the users (such as
  466.         SMILES.)
  467.  
  468.         SabreChat! will support up to sixty action commands, each
  469.         being no longer than 80 characters.
  470.  
  471.         After modifying the file SCHT!ACT.TXT, you will need to run
  472.         SCHT!ACT.EXE.  This will convert SCHT!ACT.TXT into
  473.         SCHT!ACT.DAT that is read by SabreChat!.  SCHT!ACT.EXE will
  474.         notify you if you have made any mistakes regarding the size of
  475.         an action command.
  476.  
  477. Technical Information
  478. ─────────────────────
  479.  
  480.         Following is some technical information that may be useful in
  481.         debugging application conflicts.
  482.  
  483.         ■ The communication fossil is expected to be at interrupt 14h.
  484.         ■ NetBIOS is accessed through interrupt 5Ch.
  485.         ■ Interrupt 66h is used to communicate with SabreMixer!.
  486.         ■ NetBIOS datagrams are used in NetBIOS mode.
  487.         ■ Record locking is used to safely access NODEINFO.DAT.
  488.  
  489. Thanks
  490. ──────
  491.  
  492.         I'd like to take this moment to thank Greg Day for starting me
  493.         on the Wildcat! version and for suppling the information that
  494.         made it possible, and most of all for alpha testing this on
  495.         his system, SCC BBS 1-313-427-0223. Thanks Greg.
  496.  
  497.         Also special thanks to Jeff Shapiro, for his addition help in
  498.         taming the paging errors and directory setup.  Thanks Jeff!!
  499.  
  500.         More special thanks to beta tester #3, Steve Henry, for combing
  501.         out those last few bugs before release!!
  502.  
  503.         These are the people that made SabreChat! possible:
  504.  
  505.         Greg Day                        Steve Henry
  506.         Suburban Computer Connection    AMBASSADOR BOARD
  507.         Garden City, MI                 Ontario, Canada
  508.         (313)427-0223                   (519)925-0724 v.32bis
  509.         1:2410/193@FIDONET
  510.  
  511.         Jeff Shapiro
  512.         Computer Junction
  513.         Elizabeth, NJ
  514.         908-354-6979
  515.         1:107/900@FIDONET
  516.  
  517.                                         - Shawn Gresham
  518.  
  519. Future Versions
  520. ───────────────
  521.  
  522.         Here are a few ideas that my beta testers and I have come
  523.         up with for future versions:
  524.  
  525.         * adding a KNOCK command for users to request entrance to a
  526.           private conference (room)
  527.         * expanding the IGNORE command to allow a user to ignore a
  528.           certain node
  529.         * possibly adding a sysop page option and apporiate handling
  530.         * detection of users logging on/off the board...
  531.         * room ownership. this would give ownership of a room to the
  532.           creater who would be given extra commands for moderating the
  533.           room: FORCE to force a user back to the PUBLIC room, GRANT
  534.           to grant ownership to another users, and possibly more
  535.  
  536.         Let me know what you think or if you have any other
  537.         suggestions.
  538.  
  539. Contacting The Author
  540. ─────────────────────
  541.  
  542.         You can reach the author by sending netmail to SHAWN GRESHAM
  543.         on the following board:
  544.  
  545.                 Ellwye's Funhouse
  546.                 Sherman, Texas USA
  547.                 FIDO 1:19/130
  548.                 1-903-892-4963
  549.  
  550.         Or by sending a letter to:
  551.  
  552.                 Shawn Gresham
  553.                 Route 1 Box 544
  554.                 Gordonville, Texas 76245-9789 USA
  555.  
  556.         Or, by dropping a message on the WILDCAT echo to SHAWN
  557.         GRESHAM.
  558.  
  559.         Any comments or suggestions would be treasured.
  560.  
  561.         If you are having problems and wish to contact me, please
  562.         have the following information available:
  563.  
  564.                 Machine types. (8086, 80286-10, 80486DX-50, etc)
  565.                 Memory Manager (if any) (QEMM, 386MAX, etc...)
  566.                 System Type (DESQview, network, WINDOWS, etc...)
  567.                 Operating System (MS-DOS 3.3, MS-DOS 5.0, DRDOS 6.0, etc...)
  568.                 Number of nodes in your system
  569.                 Command line used for SabreChat! (as in the MAIN1.RUN)
  570.                 Command line used for SabreMixer! (as in AUTOEXEC.BAT)
  571.                 Current SCHAT!= environment setting (as in AUTOEXEC.BAT)
  572.  
  573.         This information is invaluable for debugging SabreChat! problems.
  574.  
  575.                ──────────────────────────────────────────────
  576.                  SabreChat! Copyright (C) 1993 Shawn Gresham
  577.  
  578.  
  579.